2024-06-15 1526 главное правило написания комментариев
Для написания полезных документирующих комментариев к исходному коду достаточно придерживаться следующего правила.
- Действия (функции и методы, выражения и утверждения) должны отвечать на вопрос "Что делает?"
- Структуры хранения данных (типы данных, поля, постоянные и переменные, а также интерфейсы и классы) должны отвечать на вопрос "Что это?"
Благодарю человека, который в 2010-м подсказал мне это правило, чем упростил написание аккуратного кода.